/**

Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016.  All rights reserved.

Contact:
     SYSTAP, LLC DBA Blazegraph
     2501 Calvert ST NW #106
     Washington, DC 20008
     licenses@blazegraph.com

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
package com.bigdata.journal;

import java.io.File;

/**
 * Interface for the outcome of a snapshot task.,
 * 
 * @author bryan
 * 
 * @see <a href="http://trac.bigdata.com/ticket/1172"> Online backup for Journal
 *      </a>
 */
public interface ISnapshotResult {

   /**
    * The current root block for the snapshot. The snapshot will be consistent
    * as of the commit point associated with this root block.
    */
   IRootBlockView getRootBlock();

   /**
    * The file on which the snapshot was written.
    */
   File getFile();

   /**
    * <code>true</code> iff the snapshot was compressed.
    */
   boolean getCompressed();
   
}
